home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / arexx / arexg10c.lha / ARexxGuide / ARexxGuide1_0c.readme < prev    next >
Encoding:
Text File  |  1993-11-04  |  7.0 KB  |  198 lines
  1. Short: Complete ARexx reference. AmigaGuide.
  2. Type: util/rexx
  3. Uploader: robin@halcyon.com
  4. Author: robin@halcyon.com
  5.  
  6.  DESCRIPTION
  7.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  8. ARexxGuide is a complete ARexx reference with tutorials and
  9. examples. It includes argument templates and descriptions of all
  10. instruction keywords, of built-in functions, and of the functions
  11. in rexxsupport.library. The basic elements of the language are
  12. fully explained. Example programs and clauses are included with the
  13. explanations.
  14.  
  15. It is a shareware offering. The suggested fee is $15.
  16.  
  17.  VERSION
  18.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  19. Version 1.0C
  20.  
  21. Added note on single-clause persistence of DATE() and TIME()
  22. values. A few more typos found and fixed.
  23.  
  24. Version 1.0B
  25.  
  26. Minor changes to formatting were made in several files. Some
  27. additional errata was corrected.
  28.  
  29. Version 1.0A
  30.  
  31. This fixes reported typos, some bad link directions (especially in the
  32. Tutorial section), and some problems experienced with the example
  33. scripts.
  34.  
  35. A patch file called ARexxGdFix1_0A.lha (at most locations) is
  36. available for those who have downloaded version 1.0 of the guide.
  37. That patch file contains all of the files to which significant
  38. changes were made. Some additional formatting changes have been
  39. included in other files.
  40.  
  41.  
  42.  ARCHIVE CONTENTS
  43.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44. The ARexxGuide drawer of this archive contains 20 files that make
  45. up one AmigaGuide® application. The AmigaGuide files are:
  46.  
  47.   ArexxGuide.guide                 ArexxGuide.guide.info
  48.   ARx_Cmd.ag                       ARx_Elements.ag
  49.   ARx_Elements2.ag                 ARx_Elements3.ag
  50.   ARx_Func.ag                      ARx_Func2.ag
  51.   ARx_Func3.ag                     ARx_Func4.ag
  52.   ARx_Index                        ARx_Instr.ag
  53.   ARx_Instr2.ag                    ARx_Instr3.ag
  54.   ARx_Intro.ag                     ARx_Notes.ag
  55.   ARx_Operator.ag                  ARx_PrgUcr.ag
  56.   ARx_UcrTutor1.ag                 ARx_UcrTutor2.ag
  57.  
  58. Only ARexxGuide.guide is intended as an AmigaGuide executable. The
  59. other files are called from within the main node of that guide.
  60.  
  61. The following ARexx script files, located in the same directory,
  62. are used to run interactive examples from ARexxGuide:
  63.  
  64.   ARx_Cmpr.rexx                    ARx_IactExamples.rexx
  65.   ARx_Reg.rexx                     Arx_Trace.rexx
  66.  
  67. The 'Extras' drawer contains some files that are not necessary, but
  68. may be helpful to some users. A Readme file in that directory
  69. explains those files.
  70.  
  71. The file 'UnCrunch.rexx' is the the source document for the program
  72. included in the tutorial section.
  73.  
  74.  INSTALLATION
  75.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76. The ARexxGuide drawer can be moved to any location.
  77.  
  78. The #?.rexx files in the drawer may, optionally, be moved to the
  79. system REXX: directory. The following command will do that:
  80.  
  81.    copy <path>/ARexxGuide/#?.rexx REXX:
  82.    delete <path>/ARexxGuide/#?.rexx
  83.  
  84.  RUNNING ARexxGuide
  85.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  86. From the icon:
  87.    Double-click on the ARexxGuide.guide icon. ARexxGuide will open
  88.    its window.
  89.  
  90.    The default tool in the icon is 'AmigaGuide' without path
  91.    specification. If your AmigaGuide executable program is located
  92.    in a path that is searched by Workbench, then that will be
  93.    enough. If, however, AmigaGuide cannot be found by Workbench,
  94.    then you should single-click on the icon and press Amiga-I.  Add
  95.    the full path to the 'Default tool:' field in the Information
  96.    window.
  97.  
  98.       Example:
  99.             sys:utilities/Amigaguide
  100.  
  101.    If you use Multiview instead of AmigaGuide, then you may need to
  102.    change the default tool.
  103.  
  104.    When ARexxGuide is called from the icon, the .rexx interactive
  105.    examples will run, even if they are not moved to the rexx:
  106.    directory.
  107.  
  108. From a shell:
  109.    You have more options when you run ARexxGuide from a shell, but
  110.    may also run into a few more problems because this guide uses
  111.    multiple files. When pressing one of the link buttons in the
  112.    guide, AmigaGuide will often look for one of the subsidiary
  113.    files. It will find them if they are in the current directory or
  114.    if they are in a path included in the AmigaGuide/path
  115.    environmental variable.
  116.  
  117.  --- Run ARexxGuide from the current directory.
  118.  
  119.    Make the directory containing ARexxGuide.guide the current
  120.    directory before calling the guide:
  121.  
  122.       Example:
  123.          cd <path>/ARexxGuide
  124.          Amigaguide ARexxGuide.guide
  125.  
  126.    Interactive .rexx examples will run even if they are not moved
  127.    to REXX: when the guide is invoked this way.
  128.  
  129.  --- Add the ARexxGuide path the AmigaGuide search path.
  130.  
  131.    AmigaGuide will look for files in directories specified in the
  132.    environmental variable amigaguide/path. If you often run this
  133.    guide from a shell or directory utility, you should probably set
  134.    the variable.
  135.  
  136.    The following command, issued from a shell, will set a search
  137.    path for AmigaGuide:
  138.  
  139.       makedir env:amigaguide
  140.       setenv amigaguide/path <path>/ARexxGuide
  141.  
  142.    where <path> is the full path leading to the directory.
  143.  
  144.    If you've already created an 'amigaguide' path in env:, then you
  145.    may omit the makedir command.
  146.  
  147.    Note that this command will replace any value that might
  148.    previously have been set for the path variable. You can,
  149.    however, include multiple paths in that variable. Just separate
  150.    each path from others with a space and use the collection in the
  151.    'setenv' command.
  152.  
  153.    The env: directory is located by default in RAM:, so this
  154.    setting will not survive a reboot. If you'd like to have path
  155.    automatically set when you reboot, issue this command:
  156.  
  157.       copy env:amigaguide/#? envarc:
  158.  
  159.    If that command is issued after you have opened and closed
  160.    AmigaGuide, then the window size and position last used will
  161.    also be saved.
  162.  
  163.    Once the search path for AmigaGuide is set, ARexxGuide can be
  164.    run without setting the current directory. The interactive
  165.    examples, however, might not run. They should be moved to the
  166.    REXX: directory to so that ARexx will be able to find them.
  167.  
  168.  DISTRIBUTION
  169.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  170. The files in this archive are copyright 1993, Robin Evans and may
  171. be distributed only in the original form and only under the
  172. conditions outlined below.
  173.  
  174. The archive may be distributed in its original form on any
  175. non-commercial media, on local and national computer networks, on
  176. Aminet distribution channels (including the Walnut Creek CD-ROM),
  177. and on the Fish Disks.
  178.  
  179. Distribution of the copyrighted material in this archive is
  180. prohibited if the contents of the original archive are in any way
  181. altered.
  182.  
  183. Rights are reserved to other forms of distribution of this archive
  184. or of its contents individually, including distribution with
  185. commercial products or distribution of printed versions of any
  186. copyrighted file contained in the archive. Contact the author for
  187. information about distribution.
  188.  
  189.                Robin Evans                   22 Oct 1993
  190.                   R.EVANS6   on GEnie
  191.  
  192.                   from Internet:
  193.                      robin@halcyon.com
  194.                      r.evans6@genie.geis.com
  195.  
  196.                   by phone:
  197.                      (206) 682-7077
  198.